From 38469882119926241d61dd79e9fec0dde7f8fda9 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Sun, 3 Oct 2010 00:28:54 +0200 Subject: [PATCH] docs: Move documentation to inline comments: GtkToolbar --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtktoolbar.sgml | 305 ------------------------ gtk/gtktoolbar.c | 23 ++ 3 files changed, 24 insertions(+), 305 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktoolbar.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 54e4684190..57eac13dc6 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -40,6 +40,7 @@ gtktesting.sgml gtktextiter.sgml gtktexttagtable.sgml gtktoggleaction.sgml +gtktoolbar.sgml gtktoolitem.sgml gtktreednd.sgml gtktypeutils.sgml diff --git a/docs/reference/gtk/tmpl/gtktoolbar.sgml b/docs/reference/gtk/tmpl/gtktoolbar.sgml deleted file mode 100644 index ce04c4ebf4..0000000000 --- a/docs/reference/gtk/tmpl/gtktoolbar.sgml +++ /dev/null @@ -1,305 +0,0 @@ - -GtkToolbar - - -Create bars of buttons and other widgets - - - -A toolbar is created with a call to gtk_toolbar_new(). - - -A toolbar can contain instances of a subclass of #GtkToolItem. To add -a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove -an item from the toolbar use gtk_container_remove(). To add a button -to the toolbar, add an instance of #GtkToolButton. - - -Toolbar items can be visually grouped by adding instances of -#GtkSeparatorToolItem to the toolbar. If a #GtkSeparatorToolItem has -the "expand" property set to #TRUE and the "draw" property set to -#FALSE the effect is to force all following items to the end of the -toolbar. - - -Creating a context menu for the toolbar can be done by connecting to -the #GtkToolbar::popup-context-menu signal. - - - - - - - -#GtkToolItem -Base class of widgets that can be added to a toolbar. - - - - - - - - - - - - - -The #GtkToolbar struct only contains private data and should only be -accessed through the function described below. - - - - - - - - -@toolbar: the object which received the signal. -@arg1: -@Returns: - - - - - - -@toolbar: the object which received the signal. -@orientation: the new #GtkOrientation of the toolbar. - - - - - - -@toolbar: the object which received the signal. -@Returns: -@Returns: -@Returns: -@Returns: - - - - - - -@toolbar: -@style: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@GTK_TOOLBAR_SPACE_EMPTY: -@GTK_TOOLBAR_SPACE_LINE: - - - - - - -@void: -@Returns: the newly-created toolbar. - - - - - - - -@toolbar: -@item: -@pos: - - - - - - - -@toolbar: -@item: -@Returns: - - - - - - - -@toolbar: -@Returns: - - - - - - - -@toolbar: -@n: -@Returns: - - - - - - - -@toolbar: -@x: -@y: -@Returns: - - - - - - - -@toolbar: -@tool_item: -@index_: - - - - - - - -@toolbar: -@show_arrow: - - - - - - - -@toolbar: - - - - - - - -@toolbar: -@Returns: - - - - - - - -@toolbar: -@Returns: - - - - - - - -@toolbar: -@Returns: - - - - - - - -@toolbar: -@Returns: - - - - - - - -@toolbar: -@style: - - - - - - - -@toolbar: -@icon_size: - - - - - - - -@toolbar: - - diff --git a/gtk/gtktoolbar.c b/gtk/gtktoolbar.c index 3a3d7af089..7281544cce 100644 --- a/gtk/gtktoolbar.c +++ b/gtk/gtktoolbar.c @@ -59,6 +59,29 @@ #include "gtkintl.h" +/** + * SECTION:gtktoolbar + * @Short_description: Create bars of buttons and other widgets + * @Title: GtkToolbar + * @See_also: #GtkToolItem + * + * A toolbar is created with a call to gtk_toolbar_new(). + * + * A toolbar can contain instances of a subclass of #GtkToolItem. To add + * a #GtkToolItem to the a toolbar, use gtk_toolbar_insert(). To remove + * an item from the toolbar use gtk_container_remove(). To add a button + * to the toolbar, add an instance of #GtkToolButton. + * + * Toolbar items can be visually grouped by adding instances of + * #GtkSeparatorToolItem to the toolbar. If the GtkToolbar child property + * "expand" is #TRUE and the property #GtkSeparatorToolItem:draw is set to + * #FALSE, the effect is to force all following items to the end of the toolbar. + * + * Creating a context menu for the toolbar can be done by connecting to + * the #GtkToolbar::popup-context-menu signal. + */ + + typedef struct _ToolbarContent ToolbarContent; #define DEFAULT_IPADDING 0 -- 2.30.2